Skip to content

Conversation

@blunteshwar
Copy link
Contributor

Overview

This PR reorganizes the bundle README.md to follow the established documentation standards structure, improving accessibility and consistency with other component documentation.

Changes Made

Structure Reorganization

  • Overview: Replaced "Description" with "Overview" section and enhanced the explanation to better clarify the bundle's purpose for prototyping versus production use
  • Usage: Updated import code blocks with proper language syntax highlighting (bash, javascript)
  • Anatomy: Added new section describing the bundle's key parts:
    • All Spectrum Web Component element registrations
    • Base classes for components
    • Namespaced icon exports
  • Options: Created comprehensive section documenting different ways to use the bundle:
    • Component Registration for rapid prototyping
    • Type Imports for type checking and extension
  • Behaviors: Reorganized existing icon content into proper behaviors section:
    • Icon Handling with detailed explanation
    • UI Icons usage with namespace
    • Workflow Icons usage with namespace
    • Version Management considerations
  • Accessibility: Added new section referencing component-level accessibility guidelines

Content Improvements

  • Enhanced bundle description to better explain prototyping versus production use cases
  • Added proper code syntax highlighting to all code blocks
  • Improved clarity around icon namespace handling
  • Added version management guidance to help developers understand trade-offs
  • Included accessibility reference pointing to individual component documentation
  • Improved readability with better heading hierarchy and organization
  • Changed "renamed to" to "is renamed to" for consistency in icon documentation
  • Used "is namespaced" for workflow icons to maintain parallel structure

Documentation Standards Compliance

  • Follows structure outlined in Adding a Component Documentation Standards
  • Maintains consistency with accordion, button, meter, progress bar, progress circle, and tooltip README files
  • Uses sentence case for all headings
  • Applies proper markdown formatting with code blocks and language tags
  • Ensures all examples are accessible and properly formatted

Testing

  • Verified all existing content is preserved
  • Confirmed proper markdown syntax and formatting
  • Checked consistency with documentation standards
  • Reviewed that all code blocks have appropriate language tags

Related Documentation

  • Follows structure outlined in Adding a Component Documentation Standards
  • Maintains consistency with other component README files across the Spectrum Web Components library
  • References PR #5663 (color-handle documentation reorganization) as a model

This reorganization makes the bundle documentation more accessible, easier to navigate, and consistent with the established documentation standards across the Spectrum Web Components library.

@blunteshwar blunteshwar requested a review from a team as a code owner October 28, 2025 08:23
@changeset-bot
Copy link

changeset-bot bot commented Oct 28, 2025

⚠️ No Changeset found

Latest commit: e59c502

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Oct 28, 2025

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5836

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@blunteshwar blunteshwar requested a review from nikkimk October 28, 2025 08:28
@github-actions
Copy link
Contributor

Tachometer results

Currently, no packages are changed by this PR...

@coveralls
Copy link
Collaborator

coveralls commented Oct 28, 2025

Pull Request Test Coverage Report for Build 19063791377

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.966%

Totals Coverage Status
Change from base Build 18982870623: 0.0%
Covered Lines: 34259
Relevant Lines: 34788

💛 - Coveralls

Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me


The bundle consists of several key parts:

- All Spectrum Web Component element registrations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- All Spectrum Web Component element registrations
- All Spectrum Web Component elements registrations

Comment on lines 30 to 32
- All Spectrum Web Component element registrations
- Base classes for all components available for type checking and extension
- Namespaced icon exports for UI and workflow icons
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also share one example each for quick reference for the users.

Comment on lines 50 to 54
```javascript
import { ActionButton } from '@spectrum-web-components/bundle';
import { Button } from '@spectrum-web-components/bundle';
import { Tooltip } from '@spectrum-web-components/bundle';
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you revisit this? This is not correct

@blunteshwar blunteshwar enabled auto-merge (squash) November 6, 2025 14:37
@blunteshwar blunteshwar merged commit 0173074 into main Nov 6, 2025
23 of 24 checks passed
@blunteshwar blunteshwar deleted the SWC-426 branch November 6, 2025 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants